From: Julian Sparber <julian@sparber.net>
Date: Thu, 8 Feb 2024 09:27:03 +0000 (+0100)
Subject: st/button: Fix small mistake in st_button_toggle_mode docs
X-Git-Tag: archive/raspbian/50.5-1+rpi1~1^2~281^2~2^2~20
X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=7b5da30f212f9fbe3f7beaa7fe426ae0404cf371;p=gnome-shell.git

st/button: Fix small mistake in st_button_toggle_mode docs

When the toggle mode is enabled the checked state will be changed not
the active state.

Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3172>
---

diff --git a/src/st/st-button.c b/src/st/st-button.c
index 42745f361..21710020e 100644
--- a/src/st/st-button.c
+++ b/src/st/st-button.c
@@ -821,7 +821,7 @@ st_button_get_toggle_mode (StButton *button)
  * @button: a #Stbutton
  * @toggle: %TRUE or %FALSE
  *
- * Enables or disables toggle mode for the button. In toggle mode, the active
+ * Enables or disables toggle mode for the button. In toggle mode, the checked
  * state will be "toggled" when the user clicks the button.
  */
 void